The Dreamweaver JavaScript API > File manipulation functions > dreamweaver.getKeyState()

 

dreamweaver.getKeyState()

Availability

Dreamweaver 3.0

Description

Determines whether the specified modifier key is down.

Arguments

key

key must be one of the following: "Cmd", "Ctrl", "Alt", or "Shift". In Windows, "Cmd" and "Ctrl" both refer to the Control key; on the Macintosh, "Alt" refers to the Option key.

Returns

A Boolean value indicating whether the key is down.

Enabler

None.

Example

The following code checks that both the Shift and Control keys (Windows) or Shift and Command keys (Macintosh) are down before performing an operation:

if (dw.getKeyState("Shift") && dw.getKeyState("Cmd")){
	// execute code
}